//=============================================================================
// System  : MatchKit
// File    : PatternBaseAttribute.cs
// Author  : Fabio Bussu  (matchkit@fabiobussu.it)
// Updated : 04/16/2013
// Note    : Copyright 2013, Fabio Bussu, All rights reserved
//
// This code is published under the Microsoft Public License (Ms-PL). A copy
// of the license should be distributed with the code.  It can also be found
// at the project website: http://matchkit.codeplex.com. This notice, the
// author's name, and all copyright notices must remain intact in all
// applications, documentation, and source files.
//
// Version     Date     Who  Comments
// ============================================================================
// 1.0.0.0  04/16/2013   FB  First draft
//=============================================================================
using System;

namespace MatchKit.ObjectMapping.Attributes
{
	/// <summary>
	/// Provides the base class to implement a custom attribute for specify which pattern 
	/// use to match a member.
	/// </summary>
	/// <conceptualLink target="7e345cd8-5aaa-4616-a3c9-abcc9943dabc" />
	/// <conceptualLink target="0a06b2a9-5f58-409a-ba62-639cfd77bca7" />
	[AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, Inherited = true, AllowMultiple = true)]
	public abstract class PatternBaseAttribute : Attribute
	{
		/// <summary>
		/// Initializes a new instance of the <see cref="PatternBaseAttribute"/> class. 
		/// </summary>
		protected PatternBaseAttribute()
		{
			// empty
		}

		/// <summary>
		/// Initializes a new instance of the <see cref="PatternBaseAttribute"/> class. 
		/// </summary>
		/// <param name="position">Priority of the attribute for the matching process.</param>
		protected PatternBaseAttribute(int position)
		{
			Position = position;
		}

		/// <summary>
		/// Gets or sets the priority which the attribute is evaluated by the matching process.
		/// </summary>
		public int Position
		{
			get;
			set;
		}

		/// <summary>
		/// Creates the specific pattern based on the attribute purpose.
		/// </summary>
		/// <param name="memberValue">Value of the member.</param>
		/// <param name="isArray">Value specifying whether the member is an array.</param>
		/// <returns>The created pattern.</returns>
		public abstract IPattern CreatePattern(object memberValue, bool isArray);
	}
}
